/**
 * Copyright (C) 2015-2018 Virgil Security Inc.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     (1) Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *     (2) Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *     (3) Neither the name of the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
 */

#ifndef VIRGIL_CRYPTO_PFS_VIRGIL_PFS_PRIVATE_KEY_H
#define VIRGIL_CRYPTO_PFS_VIRGIL_PFS_PRIVATE_KEY_H

#include "../VirgilByteArray.h"

namespace virgil { namespace crypto { namespace pfs {

/**
 * @brief This is model object that handles private key.
 *
 * @see VirgilPFS
 * @ingroup pfs
 */
class VirgilPFSPrivateKey {
public:
    /**
     * @param key - private key.
     * @param password - private key password.
     */
    explicit VirgilPFSPrivateKey(VirgilByteArray key = VirgilByteArray(), VirgilByteArray password = VirgilByteArray());

    /**
     * @return True if underlying key is not defined.
     */
    bool isEmpty() const;

    /**
     * @brief Getter.
     * @see VirgilPFSPrivateKey()
     */
    const VirgilByteArray& getKey() const;

    /**
     * @brief Getter.
     * @see VirgilPFSPrivateKey()
     */
    const VirgilByteArray& getPassword() const;

    //! @cond Doxygen_Suppress
    VirgilPFSPrivateKey(const VirgilPFSPrivateKey& other) = default;

    VirgilPFSPrivateKey& operator=(const VirgilPFSPrivateKey& other) = default;

    VirgilPFSPrivateKey(VirgilPFSPrivateKey&& other) = default;

    VirgilPFSPrivateKey& operator=(VirgilPFSPrivateKey&& other) = default;

    ~VirgilPFSPrivateKey() noexcept;
    //! @endcond

private:
    VirgilByteArray key_;
    VirgilByteArray password_;
};

}}}

#endif //VIRGIL_CRYPTO_PFS_VIRGIL_PFS_PRIVATE_KEY_H
